package com.example.profile_encryption.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    /**
     * 创建API应用
     * apiInfo() 增加API相关信息
     * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，
     * 本例采用指定扫描的包路径来定义指定要建立API的目录。
     *
     * @return
     */
    @Bean
    public Docket restApi() {
        ParameterBuilder ticketPar = new ParameterBuilder();

        ticketPar.name("Authorization").description("用户TOKEN")
                .modelRef(new ModelRef("string")).parameterType("header")
                .required(false).build(); //header中的ticket参数非必填，传空也可以


        List<Parameter> pars = new ArrayList<Parameter>();
        pars.add(ticketPar.build());    //根据每个方法名也知道当前方法在设置什么参数


        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("标准接口")
                .globalOperationParameters(pars)
                .apiInfo(apiInfo("Spring Boot中使用Swagger2构建Restful APIs", "1.0"))
                .useDefaultResponseMessages(true)
                .forCodeGeneration(false)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.profile_encryption.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    //在这里指定了第二个接口层的位置，同时指定了它的路径前缀，这样我们在swagger页面中就能很方便很清晰的找到它里面的接口了
//    @Bean
//    public Docket restApi2() {
//        return new Docket(DocumentationType.SWAGGER_2)
//                .groupName("其他接口")
//                .apiInfo(apiInfo("Other APIs", "2.0"))
//                .select()
//                .apis(RequestHandlerSelectors.basePackage("com.xqnode.learning.other"))
//                .paths(PathSelectors.regex("/other.*"))
//                .build();
//    }

    /**
     * 创建该API的基本信息（这些基本信息会展现在文档页面中）
     * 访问地址：http://ip:port/swagger-ui.html
     *
     * @return
     */
    private ApiInfo apiInfo(String title, String version) {
        return new ApiInfoBuilder()
                .title(title)
                .description("参考网址: https://blog.csdn.net/xqnode")
                .termsOfServiceUrl("https://blog.csdn.net/weixin_44001521")//这里配置的是服务网站
                .contact(new Contact("广大菜鸟", "https://blog.csdn.net/weixin_44001521", "WOSHIWUBINDONG@163.com"))
                .version(version)
                .build();
    }
}